---
title: Installation
sidebar:
  order: 1
description: Learn how to install GenAIScript as a Visual Studio Code extension
  or use it via command line for seamless integration into your development
  workflow.
keywords: Visual Studio Code, GenAIScript extension, command line tool, manual
  installation, Node.js
hero:
  image:
    alt: A simple and colorful flat 2D image shows a geometric computer screen with
      the Visual Studio Code logo, next to a small 8-bit style terminal window
      marked by the Node.js logo, and a stylized folder tree highlighting a
      .vsix file box. The design uses only five bright corporate colors, lacks
      background, people, or text, and features only iconic shapes with no
      shadows or gradients in a compact square format.
    file: ./installation.png

---

import { Image } from "astro:assets"
import { FileTree } from "@astrojs/starlight/components"
import { Steps } from "@astrojs/starlight/components"

import extensionViewSrc from "../../../assets/vscode-extensions-view.png"
import extensionViewAlt from "../../../assets/vscode-extensions-view.png.txt?raw"

import marketplaceSrc from "../../../assets/vscode-marketplace.png"
import marketplaceAlt from "../../../assets/vscode-marketplace.png.txt?raw"

import vscodeViewSrc from "../../../assets/vscode-genaiscript-view.png"
import vscodeViewAlt from "../../../assets/vscode-genaiscript-view.png.txt?raw"

GenAIScript is available as a [command line](#command-line) or a [Visual Studio Code Extension](#visual-studio-code-extension).

## Node.JS

GenAIScript requires [Node.JS](https://nodejs.org/) to run.
We recommend installing the LTS version using a [node version manager](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).

<Steps>

<ol>

<li>

Install Node.JS (node) [with a package manager](https://nodejs.org/en/download/package-manager).
**You need at least Node.JS v22.**

</li>

<li>

Check your installation

```sh
node -v
npx -v
```

You should see something similar or higher than the following versions:

```text
v22.16.0
10.5.0
```

</li>

</ol>

</Steps>

## Visual Studio Code Extension

The [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=genaiscript.genaiscript-vscode)
contains the latest stable release of the [extension](https://marketplace.visualstudio.com/items?itemName=genaiscript.genaiscript-vscode).

<Steps>

<ol>

<li>

Install [Visual Studio Code](https://code.visualstudio.com/Download).

Visual Studio Code is a lightweight but powerful source code editor which runs on your desktop and is available for Windows, macOS and Linux.

</li>

<li>
Open your project folder in Visual Studio Code.

</li>
<li>
Click on the **Extensions** view

<Image src={extensionViewSrc} alt={extensionViewAlt} />

</li>
<li>

Search **genaiscript** and click **Install**.

<Image src={marketplaceSrc} alt={marketplaceAlt} />

</li>

<li>

If successful, you will see the icon in the **Extensions** view.

<Image src={vscodeViewSrc} alt={vscodeViewAlt} />

</li>

<li>

(Optional) Click on the ⚙️ gearwheel icon on the extension page and select **Add to Workspace Recommendations**.

</li>

</ol>

</Steps>

To install a specific version of the extension, we recommend storing the `genaiscript.vsix`
in your repository and using the manual installation steps.

### Default Profile for Terminal

GenAIScript launches a node server in the default terminal. If the default terminal is not configured
or does not support node.js, you may need to update it in your user/workspace settings.

- Open command palette `Ctrl+Shift+P` and search for `Terminal: Select Default Profile`.
- Select the terminal profile like **Git Bash**

### Manual Installation (Advanced)

The latest development build of the extension is also available on through the GitHub releases. This allows access
to bug fixes earlier than the marketplace release.

<Steps>

<ol>

<li>

Open the [latest release](https://github.com/microsoft/genaiscript/releases/latest/) on GitHub

</li><li>

Download the `genaiscript.vsix` into your project root folder

<FileTree>

- ...
- .genaiscript/ folder created by the extension to store supporting files
    - cache/ various cache files
    - retrieval/ retrieval database caches
    - ... supporting files
- **genaiscript.vsix**

</FileTree>

</li><li>

Open your project in Visual Studio Code

</li><li>

Right click on the `.vsix` file and select **Install Extension VSIX...**

</li>

</ol>

</Steps>

:::note[Cursor Support]

GenAIScript can be installed in [Cursor](https://cursor.sh/how-to-install-extension)
using the manual installation steps.

:::

## Command Line

The [genaiscript](/genaiscript/reference/cli/) command line tool lets you run your GenAIScript
from any terminal.

```sh
npx genaiscript run my-script some/path/*.pdf
```

`npx` will automatically install and cache the CLI.

:::tip

**npx can be slow**. Learn how to install locally in the [cli reference](/genaiscript/reference/cli/).

:::

## DevContainer

You can add this file in your project to use GenAIScript in a
[DevContainer](https://containers.dev/), it contains a minimum of tools to get started..

```json title=".devcontainer/devcontainer.json"
{
    "image": "mcr.microsoft.com/devcontainers/typescript-node:20",
    "customizations": {
        "vscode": {
            "extensions": ["genaiscript.genaiscript-vscode"]
        }
    }
}
```

The devcontainer definition will automatically be used by
[GitHub CodeSpaces](https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers),
the [devcontainer cli](https://github.com/devcontainers/cli)
or various [editor integrations](https://containers.dev/supporting).

## Next steps

Let's configure the [LLM connection information](/genaiscript/getting-started/configuration)
